package alert

Import Path
	github.com/K-Phoen/grabana/alert (on go.dev)

Dependency Relation
	imports 6 packages, and imported by 5 packages

Involved Source Files

	    alert.go
	    condition.go
	    queries.go
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type Alert (struct)
		Alert represents an alert that can be triggered by a query.

		Fields (total 4)
			Builder *sdk.Alert
			DashboardUID string
			Datasource string
				For internal use only

			PanelID string
		Methods (total 3)
			(*Alert) HookDashboardUID(uid string)
			(*Alert) HookDatasourceUID(uid string)
			(*Alert) HookPanelID(id string)
		As Outputs Of (at least 3)
			func New(name string, options ...Option) *Alert
			func github.com/K-Phoen/grabana/dashboard.(*Builder).Alerts() []*Alert
			func github.com/K-Phoen/grabana/row.(*Row).Alerts() []*Alert
		As Inputs Of (at least one exported)
			func github.com/K-Phoen/grabana.(*Client).AddAlert(ctx context.Context, namespace string, alertDefinition Alert, datasourcesMap map[string]string) error

	 type Channel (struct)
		Channel represents an alert notification channel.
		See https://grafana.com/docs/grafana/latest/alerting/notifications/#notification-channel-setup

		Fields (total 4)
			ID uint
			Name string
			Type string
			UID string

	 type ConditionEvaluator (func)
		ConditionEvaluator represents an option that can be used to configure a condition.

		As Outputs Of (at least 5)
			func HasNoValue() ConditionEvaluator
			func IsAbove(value float64) ConditionEvaluator
			func IsBelow(value float64) ConditionEvaluator
			func IsOutsideRange(min float64, max float64) ConditionEvaluator
			func IsWithinRange(min float64, max float64) ConditionEvaluator
		As Inputs Of (at least 2)
			func If(reducer QueryReducer, queryRef string, evaluator ConditionEvaluator) Option
			func IfOr(reducer QueryReducer, queryRef string, evaluator ConditionEvaluator) Option

	 type ErrorMode string (basic type)
		ErrorMode represents the behavior of an alert in case of execution error.

		As Inputs Of (at least one exported)
			func OnExecutionError(mode ErrorMode) Option
		As Types Of (total 3)
			const ErrorAlerting
			const ErrorKO
			const ErrorOK

	 type NoDataMode string (basic type)
		NoDataMode represents the behavior of an alert when no data is returned by
		the query.

		As Inputs Of (at least one exported)
			func OnNoData(mode NoDataMode) Option
		As Types Of (total 3)
			const NoDataAlerting
			const NoDataEmpty
			const NoDataOK

	 type Operator string (basic type)
		Operator represents a logical operator used to chain conditions.

		As Types Of (total 2)
			const And
			const Or

	 type Option (func)
		Option represents an option that can be used to configure an alert.

		As Outputs Of (at least 15)
			func Description(content string) Option
			func EvaluateEvery(interval string) Option
			func For(duration string) Option
			func If(reducer QueryReducer, queryRef string, evaluator ConditionEvaluator) Option
			func IfOr(reducer QueryReducer, queryRef string, evaluator ConditionEvaluator) Option
			func OnExecutionError(mode ErrorMode) Option
			func OnNoData(mode NoDataMode) Option
			func Runbook(url string) Option
			func Summary(content string) Option
			func Tags(tags map[string]string) Option
			func WithGraphiteQuery(ref string, query string, options ...graphite.Option) Option
			func WithInfluxDBQuery(ref string, query string, options ...influxdb.Option) Option
			func WithLokiQuery(ref string, query string, options ...loki.Option) Option
			func WithPrometheusQuery(ref string, query string, options ...prometheus.Option) Option
			func WithStackdriverQuery(query *stackdriver.Stackdriver) Option
		As Inputs Of (at least 3)
			func New(name string, options ...Option) *Alert
			func github.com/K-Phoen/grabana/graph.Alert(name string, opts ...Option) graph.Option
			func github.com/K-Phoen/grabana/timeseries.Alert(name string, opts ...Option) timeseries.Option

	 type QueryReducer string (basic type)
		QueryReducer represents a function used to reduce a query to a single value
		that can then be fed to the evaluator to determine if the alert will be
		triggered or not.

		As Inputs Of (at least 2)
			func If(reducer QueryReducer, queryRef string, evaluator ConditionEvaluator) Option
			func IfOr(reducer QueryReducer, queryRef string, evaluator ConditionEvaluator) Option
		As Types Of (total 9)
			const Avg
			const Count
			const Diff
			const Last
			const Max
			const Median
			const Min
			const PercentDiff
			const Sum


Package-Level Functions (total 21)

	 func Description(content string) Option
		Description sets the description associated to the alert.

	 func EvaluateEvery(interval string) Option
		EvaluateEvery defines the evaluation interval.

	 func For(duration string) Option
		For sets the time interval during which a query violating the threshold
		before the alert being actually triggered.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#for

	 func HasNoValue() ConditionEvaluator
		HasNoValue will match queries returning no value.

	 func If(reducer QueryReducer, queryRef string, evaluator ConditionEvaluator) Option
		If defines a single condition that will trigger the alert.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#conditions

	 func IfOr(reducer QueryReducer, queryRef string, evaluator ConditionEvaluator) Option
		IfOr defines a single condition that will trigger the alert.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#conditions

	 func IsAbove(value float64) ConditionEvaluator
		IsAbove will match queries returning a value above the given threshold.

	 func IsBelow(value float64) ConditionEvaluator
		IsBelow will match queries returning a value below the given threshold.

	 func IsOutsideRange(min float64, max float64) ConditionEvaluator
		IsOutsideRange will match queries returning a value outside the given range.

	 func IsWithinRange(min float64, max float64) ConditionEvaluator
		IsWithinRange will match queries returning a value within the given range.

	 func New(name string, options ...Option) *Alert
		New creates a new alert.

	 func OnExecutionError(mode ErrorMode) Option
		OnExecutionError defines the behavior on execution error.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#execution-errors-or-timeouts

	 func OnNoData(mode NoDataMode) Option
		OnNoData defines the behavior when the query returns no data.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#no-data-null-values

	 func Runbook(url string) Option
		Runbook sets the runbook URL associated to the alert.

	 func Summary(content string) Option
		Summary sets the summary associated to the alert.

	 func Tags(tags map[string]string) Option
		Tags defines a set of tags that will be forwarded to the notifications
		channels when the alert will tbe triggered or used to route the alert.

	 func WithGraphiteQuery(ref string, query string, options ...graphite.Option) Option
		WithGraphiteQuery adds a graphite query to the alert.

	 func WithInfluxDBQuery(ref string, query string, options ...influxdb.Option) Option
		WithInfluxDBQuery adds an InfluxDB query to the alert.

	 func WithLokiQuery(ref string, query string, options ...loki.Option) Option
		WithLokiQuery adds a loki query to the alert.

	 func WithPrometheusQuery(ref string, query string, options ...prometheus.Option) Option
		WithPrometheusQuery adds a prometheus query to the alert.

	 func WithStackdriverQuery(query *stackdriver.Stackdriver) Option
		WithStackdriverQuery adds a Stackdriver query to the alert.


Package-Level Constants (total 17)

	const And Operator = "and"
		And chains conditions with a logical AND

	const Avg QueryReducer = "avg"
		Avg defines the query to execute and computes the average of the results.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#query-condition-example

	const Count QueryReducer = "count"
		Count defines the query to execute and counts the results.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#query-condition-example

	const Diff QueryReducer = "diff"
		Diff defines the query to execute.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#query-condition-example

	const ErrorAlerting ErrorMode = "Alerting"
		Alerting will set the alert state to "alerting".

	const ErrorKO ErrorMode = "Error"
		LastState will set the alert state to its previous state.

	const ErrorOK ErrorMode = "OK"
		LastState will set the alert state to its previous state.

	const Last QueryReducer = "last"
		Last defines the query to execute and takes the last result.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#query-condition-example

	const Max QueryReducer = "max"
		Max defines the query to execute and takes the largest result.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#query-condition-example

	const Median QueryReducer = "median"
		Median defines the query to execute and computes the mediam of the results.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#query-condition-example

	const Min QueryReducer = "min"
		Min defines the query to execute and takes the smallest result.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#query-condition-example

	const NoDataAlerting NoDataMode = "Alerting"
		Error will set the alert state to "alerting".

	const NoDataEmpty NoDataMode = "NoData"
		NoData will set the alert state to "no data".

	const NoDataOK NoDataMode = "OK"
		OK will set the alert state to "ok".

	const Or Operator = "or"
		Or chains conditions with a logical OR

	const PercentDiff QueryReducer = "percent_diff"
		PercentDiff defines the query to execute.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#query-condition-example

	const Sum QueryReducer = "sum"
		Sum defines the query to execute and computes the sum of the results.
		See https://grafana.com/docs/grafana/latest/alerting/rules/#query-condition-example

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.